home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / scrmak03.zip / SCRMAKER.DOC next >
Text File  |  1992-07-27  |  10KB  |  237 lines
  1.     ───────────────────────────────────────────────────────────────────────
  2.     The Screen Maker v0.03                    (C) Bob Henderson (1:3812/10)
  3.     ───────────────────────────────────────────────────────────────────────
  4.  
  5.     F E A T U R E S
  6.     ───────────────
  7.  
  8.     ■   Create  ASC/ANS  screen  containing  the  Frontdoor recent activity
  9.         information. Just like pressing alt-r in FD.
  10.  
  11.     ■   Can do  multi-line FD systems  and create the  recent activity with
  12.         the totals from all nodes.
  13.  
  14.     ■   Can optionally  update the Frontdoors  lastcall info and  place the
  15.         users information in the 'From' section.
  16.  
  17.     ■   Create  ASC/ANS screen  with last  callers on  a SuperBBS  1.16+ or
  18.         QuickBBS 2.75+ system.
  19.  
  20.     ■   Option to limit last call screens to a single node.
  21.  
  22.     ■   Option to remove both 0 baud (local) and duplicate entries from BBS
  23.         last caller screens.
  24.  
  25.     ■   Optionally use a seperate file that  you make using one of the many
  26.         control codes and create both ASC/ANS screens from that file.
  27.  
  28.     ■   Full file locking with the use of SHARE. No need to worry about the
  29.         dreaded violation on multi-line systems.
  30.  
  31.     ■   FAST.  Can creat  the default  last callers,  Frontdoor report, and
  32.         update FD's lastcall in a matter of seconds.
  33.  
  34.     ■   Does  not use  system.log. Reads  Scallers.Bbs (SBBS)  or Today.Bbs
  35.         (QBBS) files.
  36.  
  37.     ■   Requires no additional CFG files. (unless multi-line FD system)
  38.  
  39.  
  40.     R E Q U I R E M E N T S
  41.     ───────────────────────
  42.  
  43.     1.  IBM compatible computer.
  44.  
  45.     2.  At least 60k of free memory (est).
  46.  
  47.     3.  ANSI must be loaded. All screen output is thru ANSI using int 29 to
  48.         get it done fast.
  49.  
  50.     4.  SuperBBS  1.16+  or  QuickBBS  2.75+  system  with  the environment
  51.         variable  set  for  that  system.  Either  SET  SBBS=<path>  or SET
  52.         QUICK=<path>.
  53.  
  54.     5.  If using Frontdoor you must have the SET FD=<path> set.
  55.  
  56.     6.  If  running multi-line FD  system you will need to  create a simple
  57.         text file containg the paths to each FD node. Sample File.
  58.  
  59.         <FILE BEGIN>
  60.         C:\FD\FD1
  61.         C:\FD\FD2
  62.         <FILE END>
  63.  
  64.         This file must be named the same  as the EXE file but with the .CFG
  65.     extension. It  must be also  be in the  same directory as  the EXE. The
  66.     file cannot contain any tabs or spaces before or after the paths, blank
  67.     lines are ok.
  68.  
  69.  
  70.     C O M M A N D   L I N E   S W I T C H E S
  71.     ─────────────────────────────────────────
  72.  
  73.         A short on command line switches.  Most switches can be used all at
  74.     once to have Screen Maker create several screens.
  75.  
  76.     /A      Make ANSI screens. You have to use either /F, /L or /I also.
  77.     /B      Make ASCII screens. You have to use either /F, /L or /I also.
  78.     /C      Use comma delimited numbers where possible.
  79.     /D      Don't include duplicates in last callers.
  80.     /F      Make/Display default FrontDoor stats screen.
  81.     /H      Display control code help.
  82.     /Iarg   Use  arg  file  as  input  file.  The  file  must have the .SCR
  83.             extension. If  /A or /B is  not specified it is  translated and
  84.             displayed
  85.     /L      Make/Display default Bbs Last callers screen.
  86.     /Narg   Read in only Bbs node arg for making screens. 0=ALL
  87.     /P      Add 'Press ENTER to continue.^A' prompt on internal screens.
  88.     /Oarg   Use arg as the output path for all screens.
  89.     /R      Register this program. Must have your number ready.
  90.     /Uarg   Update FrontDoors lastcall.fd with Bbs node arg last user info.
  91.             For single line systems use /U0
  92.     /Z      Don't include 0 baud ( Local ) users in last call. (SBBS Only)
  93.  
  94.     If  you don't  use the  /A or  /B switches  the screen(s)  are made and
  95.     displayed on your screen. Try scrmaker /l and see what happens.
  96.  
  97.     U S I N G   Y O U R   O W N   S C R E E N S
  98.     ───────────────────────────────────────────
  99.  
  100.         It is possible for you to  create your own last callers screens and
  101.     have The Screen  Maker substitute the values for  control codes in your
  102.     screen. You can  use a text editor or ANSI  screen drawing program such
  103.     as  TheDraw  to  make  your  screens.  The  screen  must  have the .SCR
  104.     extension or  it will not work  correctly. The codes are  placed in the
  105.     file with optional format specifiers. The formating codes are.
  106.  
  107.         \   Left justified text
  108.         /   Right justified text
  109.         |   Centered text
  110.  
  111.         All codes start with a % (percent) and then a letter. The letter is
  112.     case sensitive.
  113.  
  114.         Example codes and translations.
  115.  
  116.     %N = User Name = Bob Henderson, brackets are only for show.
  117.  
  118.     [%N]                              No formatting
  119.     [Bob Henderson]
  120.  
  121.     [%\\\\\\\\\\\\\\\\\\\\\\\\\N]     Left
  122.     [Bob Henderson              ]
  123.  
  124.     [%/////////////////////////N]     Right
  125.     [              Bob Henderson]
  126.  
  127.     [%|||||||||||||||||||||||||N]     Center
  128.     [       Bob Henderson       ]
  129.  
  130.     [%\\\\\\N]                        Not long enough
  131.     [Bob Hend]
  132.  
  133.         No is  that easy or  what? The formatting  codes will allow  you to
  134.     draw lines  around names and  such and still  retain their shape.  Here
  135.     comes the list of available code. REMEMBER, CODES ARE CASE SENSITIVE!
  136.  
  137.     Codes with  **  by them do not allow for formatting
  138.  
  139.         For the BBS info ...
  140.  
  141.     %A  Users alias             (QBBS Only)
  142.     %B  Baud rate               (SBBS Only)
  143.     %C  Users city
  144.     %D  Day user logged off     (2 digits) **
  145.     %G  Age of user             (SBBS Only)
  146.     %H  Hour user logged off    (2 digits) **
  147.     %I  Increment user count    (Read Below) **
  148.     %L  Line user was on
  149.     %M  Minute user logged off  (2 digits) **
  150.     %N  Users name
  151.     %O  Month user logged off   (2 digits) **
  152.     %P  Go back to previous user(Read Below) **
  153.     %Y  Year user logged off    (2 digits) **
  154.  
  155.         For Frontdoor info ...
  156.  
  157.     %a  Today inbound calls         %k  Yesterday inbound calls
  158.     %b  Today outbound calls        %l  Yesterday outbound calls
  159.     %c  Today humans                %m  Yesterday humans
  160.     %d  Today files in              %n  Yesterday files in
  161.     %e  Today files out             %o  Yesterday files out
  162.     %f  Today good sessions         %p  Yesterday good sessions
  163.     %g  Today bad sessions          %q  Yesterday bad sessions
  164.     %h  Today file requests         %r  Yesterday file requests
  165.     %i  Today bytes in              %s  Yesterday bytes in
  166.     %j  Today bytes out             %t  Yesterday bytes out
  167.  
  168.  
  169.         To  many codes  huh? Oh  well ..  If you  are not  makeing your own
  170.     screens you shouldn't have to worry  about them. Please note the %I and
  171.     %P switches. You must use these to move back and forth to the next user
  172.     how called.  The code does not  show up in the  display. See the sample
  173.     screens in this archive.
  174.  
  175.         When using TheDraw  to make the screens you will  need to check the
  176.     saved file and make sure that none of the formatting or codes are split
  177.     on a single  line. Irregular results may occur. It  is best to save the
  178.     screen without any  animation and I have found it  best to tell TheDraw
  179.     to use No  screen preperation. That way the screen  will be as you have
  180.     drawn without any movement commands. You can touch it up with your text
  181.     editor afterwards. If you have Screen  Maker make a ASCII screen from a
  182.     ANSI screen all ANSI codes will be removed, so animated screens without
  183.     ANSI codes look real funny.
  184.  
  185.         You can test your ouput by not using either the /A or /B switch and
  186.     have Screen Maker just display your screen.
  187.  
  188.  
  189.     L E G A L   S T U F F
  190.     ─────────────────────
  191.  
  192.     Screen Maker  is provided as is,  with no warranty of  any kind, either
  193.     expressed or  implied. Screen Maker  is only guaranteed  to occupy disk
  194.     space. You  are free to  copy and distribute  the Screen Maker  archive
  195.     freely, provided no changes or additions are made to the package.
  196.  
  197.     Bob Henderson (The  Author) shall in no event be  held liable to you or
  198.     anyone else for  any damages of ANY kind,  incidental or consequential,
  199.     arising from the use or inability to use this program.
  200.  
  201.     All products by  Bob Henderson are trademarks and  are Copyright by Bob
  202.     Henderson. Other products and brand  names are trademarks and Copyright
  203.     by the respective holders.
  204.  
  205.  
  206.     R E G I S T R A T I O N
  207.     ───────────────────────
  208.  
  209.         Registration  for this  version is  very simple  and fairly  cheap.
  210.     Basically I  am giving version 0.3  away for free. There  is a catch. I
  211.     want to know that you are using it. There are two ways to register.
  212.  
  213.     1.  If you are in Fidonet you can  send me (routed if you want) netmail
  214.         to 1:3812/10  and tell me you  are using my program  and slap me on
  215.         the back  or something. In  return I will  place on hold  a netmail
  216.         message with  your registration number.  Allow for time  for travel
  217.         time for mail and a day or so for me to get your key ready.
  218.  
  219.     2.  If your not in Fidonet you can do it by mail. Send a self addressed
  220.         stamped envelope to..
  221.  
  222.                     Bob Henderson
  223.                     302 N. Mahan
  224.                     Richwood, Tx  77531
  225.  
  226.         After receiving  your letter I  write you a  little note with  your
  227.         number and mail the envelope back to you.
  228.  
  229.         Future versions  of Screen Maker  may not be  free and may  contain
  230.     some  irritating SHAREWARE  commercials but  not for  a while. At least
  231.     until I make it run a bbs or something.
  232.  
  233.     Enjoy,
  234.     Bob Henderson,
  235.     Fidonet  1:3812/10
  236.  
  237.